TypeScript WebSocket: Elevando a Comunicação em Tempo Real com Segurança de Tipo

            
// types.ts

// Interface para enviar uma mensagem de texto
export interface SendMessagePayload {
  roomId: string;
  message: string;
}

// Interface para entrar em uma sala
export interface JoinRoomPayload {
  roomId: string;
  userId: string;
}

// Tipo de união para todas as mensagens possíveis de cliente para servidor
export type ClientToServerEvent = 
  | { type: 'SEND_MESSAGE', payload: SendMessagePayload } 
  | { type: 'JOIN_ROOM', payload: JoinRoomPayload };

            

              
                Copy
              
            
          

            
// types.ts (continuado)

// Interface para uma mensagem recebida em uma sala de chat
export interface ChatMessage {
  id: string;
  roomId: string;
  senderId: string;
  content: string;
  timestamp: number;
}

// Interface para uma notificação de usuário entrando na sala
export interface UserJoinedRoomPayload {
  userId: string;
  roomId: string;
  timestamp: number;
}

// Tipo de união para todas as mensagens possíveis de servidor para cliente
export type ServerToClientEvent = 
  | { type: 'NEW_MESSAGE', payload: ChatMessage } 
  | { type: 'USER_JOINED', payload: UserJoinedRoomPayload } 
  | { type: 'ERROR', payload: { message: string } };

            

              
                Copy
              
            
          

            
// server.ts

import WebSocket, { WebSocketServer } from 'ws';
import { ClientToServerEvent, ServerToClientEvent, ChatMessage, JoinRoomPayload, SendMessagePayload } from './types'; // Assumindo que types.ts está no mesmo diretório

const wss = new WebSocketServer({ port: 8080 });

console.log('Servidor WebSocket iniciado na porta 8080');

wss.on('connection', (ws: WebSocket) => {
  console.log('Cliente conectado');

  ws.on('message', (message: string) => {
    try {
      const parsedMessage: ClientToServerEvent = JSON.parse(message);

      switch (parsedMessage.type) {
        case 'SEND_MESSAGE':
          handleSendMessage(ws, parsedMessage.payload);
          break;
        case 'JOIN_ROOM':
          handleJoinRoom(ws, parsedMessage.payload);
          break;
        default:
          console.warn('Tipo de mensagem desconhecido recebido:', parsedMessage);
          sendError(ws, 'Tipo de mensagem desconhecido');
      }
    } catch (error) {
      console.error('Falha ao analisar mensagem:', error);
      sendError(ws, 'JSON inválido recebido');
    }
  });

  ws.on('close', () => {
    console.log('Cliente desconectado');
  });

  ws.on('error', (error) => {
    console.error('Erro no WebSocket:', error);
  });

  // Envia uma mensagem de boas-vindas ao cliente
  sendServerMessage(ws, { type: 'SYSTEM_INFO', payload: { message: 'Bem-vindo ao servidor em tempo real!' } });
});

// Função auxiliar para enviar mensagens do servidor para o cliente
function sendServerMessage(ws: WebSocket, message: ServerToClientEvent): void {
  ws.send(JSON.stringify(message));
}

// Função auxiliar para enviar erros ao cliente
function sendError(ws: WebSocket, errorMessage: string): void {
  sendServerMessage(ws, { type: 'ERROR', payload: { message: errorMessage } });
}

// Manipuladores de mensagens específicos
function handleSendMessage(ws: WebSocket, payload: SendMessagePayload): void {
  console.log(`Mensagem recebida na sala ${payload.roomId}: ${payload.message}`);
  // Em uma aplicação real, você transmitiria isso para outros usuários na sala
  const newMessage: ChatMessage = {
    id: Date.now().toString(), // Geração simples de ID
    roomId: payload.roomId,
    senderId: 'anonymous', // Em uma aplicação real, isso viria da autenticação
    content: payload.message,
    timestamp: Date.now()
  };
  // Exemplo: Transmitir para todos os clientes (substitua pela transmissão específica da sala)
  wss.clients.forEach(client => {
    if (client !== ws && client.readyState === WebSocket.OPEN) {
      sendServerMessage(client, { type: 'NEW_MESSAGE', payload: newMessage });
    }
  });
  // Opcionalmente, envie uma confirmação de volta ao remetente
  sendServerMessage(ws, { type: 'MESSAGE_SENT', payload: { messageId: newMessage.id } });
}

function handleJoinRoom(ws: WebSocket, payload: JoinRoomPayload): void {
  console.log(`Usuário ${payload.userId} entrando na sala ${payload.roomId}`);
  // Em uma aplicação real, você gerenciaria as assinaturas de sala e potencialmente transmitiria para outros
  const userJoinedNotification: UserJoinedRoomPayload = {
    userId: payload.userId,
    roomId: payload.roomId,
    timestamp: Date.now()
  };
  // Transmitir para outros na sala (exemplo)
  wss.clients.forEach(client => {
    // Isso requer lógica para saber qual cliente está em qual sala
    // Por simplicidade, enviaremos para todos aqui como exemplo
    if (client.readyState === WebSocket.OPEN) {
      sendServerMessage(client, { type: 'USER_JOINED', payload: userJoinedNotification });
    }
  });
}

// Adiciona um manipulador para um tipo de mensagem hipotético SYSTEM_INFO para completude
// Este é um exemplo de como o servidor pode enviar informações estruturadas
// Nota: Na chamada `sendServerMessage` acima, já adicionamos um tipo 'SYSTEM_INFO'
// Vamos defini-lo aqui para clareza, embora não faça parte da união `ServerToClientEvent` inicial
// Em uma aplicação real, você garantiria que todos os tipos definidos fazem parte da união
interface SystemInfoPayload {
  message: string;
}

// Para que o código acima compile, precisamos adicionar SYSTEM_INFO a ServerToClientEvent
// Para este exemplo, vamos assumir que foi adicionado:
// export type ServerToClientEvent = ... | { type: 'SYSTEM_INFO', payload: SystemInfoPayload };

// Isso demonstra a necessidade de definições de tipo consistentes.

            

              
                Copy
              
            
          

            
// client.ts

import { ClientToServerEvent, ServerToClientEvent, ChatMessage, UserJoinedRoomPayload } from './types'; // Assumindo que types.ts está no mesmo diretório

const socket = new WebSocket('ws://localhost:8080');

// Manipuladores de eventos para a conexão WebSocket

socket.onopen = () => {
  console.log('Conexão WebSocket estabelecida');
  // Exemplo: Entrar em uma sala após a conexão
  const joinRoomMessage: ClientToServerEvent = {
    type: 'JOIN_ROOM',
    payload: { roomId: 'general', userId: 'user123' }
  };
  sendMessage(joinRoomMessage);
};

socket.onmessage = (event) => {
  try {
    const message: ServerToClientEvent = JSON.parse(event.data as string);

    switch (message.type) {
      case 'NEW_MESSAGE':
        handleNewMessage(message.payload);
        break;
      case 'USER_JOINED':
        handleUserJoined(message.payload);
        break;
      case 'ERROR':
        console.error('Erro do servidor:', message.payload.message);
        break;
      case 'SYSTEM_INFO':
        console.log('Sistema:', message.payload.message);
        break;
      case 'MESSAGE_SENT':
        console.log('Mensagem enviada com sucesso, ID:', message.payload.messageId);
        break;
      default:
        console.warn('Tipo de mensagem de servidor desconhecido recebido:', message);
    }
  } catch (error) {
    console.error('Falha ao analisar mensagem do servidor:', error);
  }
};

socket.onclose = (event) => {
  if (event.wasClean) {
    console.log(`Conexão fechada de forma limpa, code=${event.code} reason=${event.reason}`);
  } else {
    console.error('Conexão morreu');
  }
};

socket.onerror = (error) => {
  console.error('Erro no WebSocket:', error);
};

// Função para enviar mensagens do cliente para o servidor
function sendMessage(message: ClientToServerEvent): void {
  if (socket.readyState === WebSocket.OPEN) {
    socket.send(JSON.stringify(message));
  } else {
    console.warn('WebSocket não está aberto. Não é possível enviar mensagem.');
  }
}

// Exemplo de envio de uma mensagem de chat após a conexão
function sendChatMessage(room: string, text: string) {
  const message: ClientToServerEvent = {
    type: 'SEND_MESSAGE',
    payload: { roomId: room, message: text }
  };
  sendMessage(message);
}

// Manipuladores de mensagens no cliente
function handleNewMessage(message: ChatMessage): void {
  console.log(
`
--- Nova Mensagem na Sala ${message.roomId} ---
De: ${message.senderId}
Tempo: ${new Date(message.timestamp).toLocaleTimeString()}
Conteúdo: ${message.content}
---------------------------
`);
  // Atualiza a UI com a nova mensagem
}

function handleUserJoined(payload: UserJoinedRoomPayload): void {
  console.log(`Usuário ${payload.userId} entrou na sala ${payload.roomId} às ${new Date(payload.timestamp).toLocaleTimeString()}`);
  // Atualiza a UI para mostrar o novo usuário na sala
}

// Exemplo de uso:
// setTimeout(() => {
//   sendChatMessage('general', 'Olá, mundo!');
// }, 3000);

            

              
                Copy
              
            
          

            
// types.ts (estendido)

// Interface genérica para qualquer evento do servidor para cliente
export interface ServerEvent<T = any> {
  type: string;
  payload: T;
}

// ServerToClientEvent atualizado usando genéricos implicitamente
export type ServerToClientEvent = 
  | ServerEvent<ChatMessage> & { type: 'NEW_MESSAGE' } 
  | ServerEvent<UserJoinedRoomPayload> & { type: 'USER_JOINED' } 
  | ServerEvent<{ message: string }> & { type: 'ERROR' } 
  | ServerEvent<{ message: string }> & { type: 'SYSTEM_INFO' } 
  | ServerEvent<{ messageId: string }> & { type: 'MESSAGE_SENT' };

// Exemplo de função receptora do lado do cliente usando genéricos
function handleServerMessage<T>(event: MessageEvent, expectedType: string, handler: (payload: T) => void): void {
  try {
    const rawMessage = JSON.parse(event.data as string) as ServerEvent;
    if (rawMessage.type === expectedType) {
      handler(rawMessage.payload as T);
    }
  } catch (error) {
    console.error(`Erro ao lidar com mensagem do tipo ${expectedType}:`, error);
  }
}

// Uso em client.ts:
// socket.onmessage = (event) => {
//   handleServerMessage<ChatMessage>(event, 'NEW_MESSAGE', handleNewMessage);
//   handleServerMessage<UserJoinedRoomPayload>(event, 'USER_JOINED', handleUserJoined);
//   handleServerMessage<{ message: string }>(event, 'ERROR', (payload) => {
//     console.error('Erro do servidor:', payload.message);
//   });
//   // ... e assim por diante
// };

            

              
                Copy
              
            
          

            
// WebSocketService.ts

import { EventEmitter } from 'events';
import { ClientToServerEvent, ServerToClientEvent } from './types';

interface WebSocketServiceOptions {
  url: string;
  reconnectInterval?: number;
  maxReconnectAttempts?: number;
}

export class WebSocketService extends EventEmitter {
  private socket: WebSocket | null = null;
  private url: string;
  private reconnectInterval: number;
  private maxReconnectAttempts: number;
  private reconnectAttempts: number = 0;
  private isConnecting: boolean = false;

  constructor(options: WebSocketServiceOptions) {
    super();
    this.url = options.url;
    this.reconnectInterval = options.reconnectInterval || 5000;
    this.maxReconnectAttempts = options.maxReconnectAttempts || 10;
  }

  connect(): void {
    if (this.socket && this.socket.readyState === WebSocket.OPEN) {
      console.log('Já conectado.');
      return;
    }
    if (this.isConnecting) {
        console.log('Conexão em andamento...');
        return;
    }

    this.isConnecting = true;
    console.log(`Tentando conectar a ${this.url}...`);
    this.socket = new WebSocket(this.url);

    this.socket.onopen = this.onOpen;
    this.socket.onmessage = this.onMessage;
    this.socket.onclose = this.onClose;
    this.socket.onerror = this.onError;
  }

  private onOpen = (): void => {
    console.log('Conexão WebSocket estabelecida.');
    this.reconnectAttempts = 0; // Reinicia as tentativas de reconexão em caso de conexão bem-sucedida
    this.isConnecting = false;
    this.emit('open');
  };

  private onMessage = (event: MessageEvent): void => {
    try {
      const message = JSON.parse(event.data as string) as ServerToClientEvent;
      this.emit('message', message);
    } catch (error) {
      console.error('Falha ao analisar mensagem:', error);
      this.emit('error', new Error('JSON inválido recebido'));
    }
  };

  private onClose = (event: CloseEvent): void => {
    console.log(`Conexão WebSocket fechada. Código: ${event.code}, Razão: ${event.reason}`);
    this.isConnecting = false;
    this.emit('close', event);
    if (event.code !== 1000) { // 1000 é o fechamento normal
      this.reconnect();
    }
  };

  private onError = (error: Event): void => {
    console.error('Erro no WebSocket:', error);
    this.isConnecting = false;
    this.emit('error', error);
    // Não reconectar automaticamente em todos os erros, depende do tipo de erro, se possível
  };

  private reconnect(): void {
    if (this.reconnectAttempts >= this.maxReconnectAttempts) {
      console.error('Máximo de tentativas de reconexão atingido. Desistindo.');
      this.emit('maxReconnects');
      return;
    }

    this.reconnectAttempts++;
    console.log(`Tentando reconectar (${this.reconnectAttempts}/${this.maxReconnectAttempts}) em ${this.reconnectInterval}ms...`);
    setTimeout(() => {
      this.connect();
    }, this.reconnectInterval);
  }

  send(message: ClientToServerEvent): void {
    if (this.socket && this.socket.readyState === WebSocket.OPEN) {
      this.socket.send(JSON.stringify(message));
    } else {
      console.warn('WebSocket não está aberto. Mensagem não enviada.');
      // Opcionalmente, enfileirar mensagens ou emitir um erro
    }
  }

  close(): void {
    if (this.socket) {
      this.socket.close();
    }
  }
}

// Exemplo de Uso no seu componente/módulo de aplicação:
// import { WebSocketService } from './WebSocketService';
// 
// const wsService = new WebSocketService({ url: 'ws://localhost:8080', reconnectInterval: 3000 });
// 
// wsService.on('open', () => {
//   console.log('Conectado!');
//   wsService.send({ type: 'SEND_MESSAGE', payload: { roomId: 'general', message: 'Olá do serviço!' } });
// });
// 
// wsService.on('message', (message: ServerToClientEvent) => {
//   console.log('Recebido via serviço:', message);
//   if (message.type === 'NEW_MESSAGE') {
//     // handleNewMessage(message.payload);
//   }
// });
// 
// wsService.on('error', (error) => {
//   console.error('O serviço encontrou um erro:', error);
// });
// 
// wsService.on('close', () => {
//   console.log('Serviço desconectado.');
// });
// 
// wsService.connect();

            

              
                Copy
              
            
          

            
// types.ts (estendido)

// Interface para uma mensagem genérica
interface GenericMessage {
  type: string;
  payload: any;
}

// Type guard para verificar se uma mensagem é de um tipo específico
function isSendMessagePayload(payload: any): payload is SendMessagePayload {
  return (
    payload &&
    typeof payload.roomId === 'string' &&
    typeof payload.message === 'string'
  );
}

// Usando o type guard na lógica do servidor
// ... dentro do manipulador wss.on('message') ...

// const parsedMessage: any = JSON.parse(message);
// 
// if (parsedMessage && typeof parsedMessage.type === 'string') {
//   switch (parsedMessage.type) {
//     case 'SEND_MESSAGE':
//       if (isSendMessagePayload(parsedMessage.payload)) {
//         handleSendMessage(ws, parsedMessage.payload);
//       } else {
//         sendError(ws, 'Payload inválido para SEND_MESSAGE');
//       }
//       break;
//     // ... outros casos
//   }
// } else {
//   sendError(ws, 'Formato de mensagem inválido');
// }

            

              
                Copy